<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcPrint.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcPrint_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">trcPrint.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Public trace print APIs.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br />
<code>#include &lt;trcTypes.h&gt;</code><br />
</div>
<p><a href="trcPrint_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2ae6438829eafbaada2b488684a272ad"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga2ae6438829eafbaada2b488684a272ad">xTracePrintCompactF0</a>(szChannel,  szFormat)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga5fcbd638f23ebbe7d9a4447d0338beca">xTraceEventCreate2</a>(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat))</td></tr>
<tr class="memdesc:ga2ae6438829eafbaada2b488684a272ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 0 parameters. Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:ga2ae6438829eafbaada2b488684a272ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaec242a14e6e62a683286115aa012a1c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#gaaec242a14e6e62a683286115aa012a1c">xTracePrintCompactF1</a>(szChannel,  szFormat,  uxParam1)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gad64822d442e36ad8b008462994442e11">xTraceEventCreate3</a>(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1)</td></tr>
<tr class="memdesc:gaaec242a14e6e62a683286115aa012a1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 1 parameter. Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:gaaec242a14e6e62a683286115aa012a1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c20dca8627818dd11ac6b34ef34bab7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga9c20dca8627818dd11ac6b34ef34bab7">xTracePrintCompactF2</a>(szChannel,  szFormat,  uxParam1,  uxParam2)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gaadf63a13e25292a1c96330dae5e520b6">xTraceEventCreate4</a>(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2)</td></tr>
<tr class="memdesc:ga9c20dca8627818dd11ac6b34ef34bab7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 2 parameters. Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:ga9c20dca8627818dd11ac6b34ef34bab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d6ffa4875c79efbab31315ca09be2a5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga4d6ffa4875c79efbab31315ca09be2a5">xTracePrintCompactF3</a>(szChannel,  szFormat,  uxParam1,  uxParam2,  uxParam3)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gaebde2bb91d01e7cc4e0c1adac58d46c4">xTraceEventCreate5</a>(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2, uxParam3)</td></tr>
<tr class="memdesc:ga4d6ffa4875c79efbab31315ca09be2a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 3 parameters. Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:ga4d6ffa4875c79efbab31315ca09be2a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga82f0f17e2189b2dadf49a45717e9ddd1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga82f0f17e2189b2dadf49a45717e9ddd1">xTracePrintCompactF4</a>(szChannel,  szFormat,  uxParam1,  uxParam2,  uxParam3,  uxParam4)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga7c11b915f0ac18234c3bd2dd7be8610a">xTraceEventCreate6</a>(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2, uxParam3, uxParam4)</td></tr>
<tr class="memdesc:ga82f0f17e2189b2dadf49a45717e9ddd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 4 parameters. Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:ga82f0f17e2189b2dadf49a45717e9ddd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff9ea3f83511637ee6330447a4c21878"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#gaff9ea3f83511637ee6330447a4c21878">xTracePrintF0</a>(xChannelStringHandle,  xFormatStringHandle)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga5fcbd638f23ebbe7d9a4447d0338beca">xTraceEventCreate2</a>(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle))</td></tr>
<tr class="memdesc:gaff9ea3f83511637ee6330447a4c21878"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 0 parameters.  <br /></td></tr>
<tr class="separator:gaff9ea3f83511637ee6330447a4c21878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7f1739d99711a57d93008ef53181fbb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#gaf7f1739d99711a57d93008ef53181fbb">xTracePrintF1</a>(xChannelStringHandle,  xFormatStringHandle,  uxParam1)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gad64822d442e36ad8b008462994442e11">xTraceEventCreate3</a>(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1)</td></tr>
<tr class="memdesc:gaf7f1739d99711a57d93008ef53181fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 1 parameter.  <br /></td></tr>
<tr class="separator:gaf7f1739d99711a57d93008ef53181fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga955568fd5e74d3c3acae96fd588cdfcf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga955568fd5e74d3c3acae96fd588cdfcf">xTracePrintF2</a>(xChannelStringHandle,  xFormatStringHandle,  uxParam1,  uxParam2)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gaadf63a13e25292a1c96330dae5e520b6">xTraceEventCreate4</a>(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2)</td></tr>
<tr class="memdesc:ga955568fd5e74d3c3acae96fd588cdfcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 2 parameters.  <br /></td></tr>
<tr class="separator:ga955568fd5e74d3c3acae96fd588cdfcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga964c84a889aad41c8e593709175e94f8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga964c84a889aad41c8e593709175e94f8">xTracePrintF3</a>(xChannelStringHandle,  xFormatStringHandle,  uxParam1,  uxParam2,  uxParam3)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#gaebde2bb91d01e7cc4e0c1adac58d46c4">xTraceEventCreate5</a>(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2, uxParam3)</td></tr>
<tr class="memdesc:ga964c84a889aad41c8e593709175e94f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 3 parameters.  <br /></td></tr>
<tr class="separator:ga964c84a889aad41c8e593709175e94f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4512199a161445907f00d027eeb59362"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga4512199a161445907f00d027eeb59362">xTracePrintF4</a>(xChannelStringHandle,  xFormatStringHandle,  uxParam1,  uxParam2,  uxParam3,  uxParam4)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga7c11b915f0ac18234c3bd2dd7be8610a">xTraceEventCreate6</a>(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2, uxParam3, uxParam4)</td></tr>
<tr class="memdesc:ga4512199a161445907f00d027eeb59362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event" with 4 parameters.  <br /></td></tr>
<tr class="separator:ga4512199a161445907f00d027eeb59362"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga37d6564a1d5f6debc318b32b40290539"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga37d6564a1d5f6debc318b32b40290539">xTracePrintCompactF</a> (const char *szChannel, const char *szFormat,...)</td></tr>
<tr class="memdesc:ga37d6564a1d5f6debc318b32b40290539"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a "User Event". Channel and format string are only stored in ELF.  <br /></td></tr>
<tr class="separator:ga37d6564a1d5f6debc318b32b40290539"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab883a6ad75c359454757ddb0503f5d3b"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#gab883a6ad75c359454757ddb0503f5d3b">xTracePrint</a> (TraceStringHandle_t xChannel, const char *szString)</td></tr>
<tr class="memdesc:gab883a6ad75c359454757ddb0503f5d3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate "User Events" with unformatted text.  <br /></td></tr>
<tr class="separator:gab883a6ad75c359454757ddb0503f5d3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ec55bf7ab9f149637723ab71f6c3f92"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga8ec55bf7ab9f149637723ab71f6c3f92">xTraceConsoleChannelPrintF</a> (const char *szFormat,...)</td></tr>
<tr class="memdesc:ga8ec55bf7ab9f149637723ab71f6c3f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper for xTracePrintF for printing to default channel.  <br /></td></tr>
<tr class="separator:ga8ec55bf7ab9f149637723ab71f6c3f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7a1c759021aaf820223232de9173c9c"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#gaf7a1c759021aaf820223232de9173c9c">xTracePrintF</a> (TraceStringHandle_t xChannel, const char *szFormat,...)</td></tr>
<tr class="memdesc:gaf7a1c759021aaf820223232de9173c9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates "User Events" with formatted text and data.  <br /></td></tr>
<tr class="separator:gaf7a1c759021aaf820223232de9173c9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55d9c4107dbd504c2d74b19880a7d307"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__print__apis.html#ga55d9c4107dbd504c2d74b19880a7d307">xTraceVPrintF</a> (TraceStringHandle_t xChannel, const char *szFormat, va_list *pxVariableList)</td></tr>
<tr class="memdesc:ga55d9c4107dbd504c2d74b19880a7d307"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates "User Events" with formatted text and data.  <br /></td></tr>
<tr class="separator:ga55d9c4107dbd504c2d74b19880a7d307"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Public trace print APIs. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcPrint_8h.html">trcPrint.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
